Skip to content

Clarify the docs for args in asyncio callbacks#143873

Open
akx wants to merge 3 commits intopython:mainfrom
akx:add-signal-handler-docs
Open

Clarify the docs for args in asyncio callbacks#143873
akx wants to merge 3 commits intopython:mainfrom
akx:add-signal-handler-docs

Conversation

@akx
Copy link
Contributor

@akx akx commented Jan 15, 2026

While working on asyncio-related things, my eyes somehow skipped over the "keyword arguments" part of the sentence about functools.partial, and args wasn't at all documented for add_signal_handler.

Hence, this PR gently clarifies the documentation for *args in asyncio loop callbacks and unifies all of the places referring to functools.partial to have similar verbiage.

I think this is a trivial enough documentation improvement that it doesn't require an issue, but let me know if not so.


📚 Documentation preview 📚: https://cpython-previews--143873.org.readthedocs.build/


Arrange for *func* to be called in the specified executor.
Arrange for *func* to be called in the specified executor
with *args* being passed as positional arguments.
Copy link
Member

@picnixz picnixz Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we use the same formulation as elsewhere (that is use either "passing...." or "with args ...")

@StanFromIreland
Copy link
Member

Updating branch to fix the CI.

Copy link
Contributor

@kumaraditya303 kumaraditya303 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

awaiting changes for Bénédikt's review

@bedevere-app
Copy link

bedevere-app bot commented Feb 6, 2026

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

4 participants